{-
	Copyright (c) 2009 Aitor Lopez Fadrique <mailto:aitorlf@gmail.com>
	All rights reserved
	Licensed under GNU LGPL v2.1

	$Id: GermanClassicDeck.hs 15 2009-09-28 21:16:23Z aitorlf $

	This program is free software; you can redistribute it and/or
	modify it under the terms of the GNU Lesser General Public
	License version 2.1 (and just under that one) as published by
	the Free Software Foundation.

	This program is distributed in the hope that it will be useful,
	but without any warranty; without even the implied warranty of
	merchantability or fitness for a particular purpose. See the GNU
	Lesser General Public License for more details.

	You should have received a copy of the GNU Lesser General Public
	License along with this program; if not, write to the Free
	Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
	MA 02111-1307, USA.
-}

{-|
	Module		: Games.Cards.GermanClassicDeck
	Copyright	: (c) Aitor Lopez Fadrique <mailto:aitorlf@gmail.com>
	License		: GNU LGPL v2.1 <http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html>

	Maintainer	: Aitor Lopez Fadrique <mailto:aitorlf@gmail.com>
	Stability	: provisional
	Portability	: portable

	Definition of the German classic (48 cards) deck according to Games.Cards.Deck.

	This module defines the basic German 48 cards classic deck.
-}
module Games.Cards.Deck.GermanClassicDeck(
		-- * German 48 cards classic deck
		-- ** Types defining cards and decks for the German classic deck
		GermanClassicRank(..),
		GermanSuit(..),
		GermanClassicCard,
		GermanClassicDeck,
		-- ** Instances of German classic decks
		germanClassicDeck,
	)where

import Games.Cards.Deck


-- | Well-known ranks for the classic German deck.
data GermanClassicRank =
		-- | 'Three' (/3/)
		Three
		-- | 'Four' (/4/)
		| Four
		-- | 'Five' (/5/)
		| Five
		-- | 'Six' (/6/)
		| Six
		-- | 'Seven' (/7/)
		| Seven
		-- | 'Eight' (/8/)
		| Eight
		-- | 'Nine' (/9/)
		| Nine
		-- | 'Banner' (/10/)
		| Banner
		-- | 'Under' (/Lower Jack/)
		| Under
		-- | 'Ober' (/Upper Jack/)
		| Ober
		-- | 'Konig' (/King/)
		| Konig
		-- | 'Daus' (/2/)
		| Daus
	deriving (Eq, Ord, Enum, Bounded, Show, Read)
instance CardRank GermanClassicRank


-- | Well-known suits for the German deck.
data GermanSuit =
		-- | 'Eichel' (/Acorns/)
		Eichel
		-- | 'Herz' (/Hearts/)
		| Herz
		-- | 'Laub' (/Leaves/)
		| Laub
		-- | 'Schellen' (/Bells/)
		| Schellen
	deriving (Eq, Enum, Bounded, Show, Read)
instance CardSuit GermanSuit


-- | Definition of the 48 cards classic German @'Card'@s and @'Deck'@s.

-- | German classic card type.
type GermanClassicCard = Card GermanClassicRank GermanSuit WildCardNone

-- | German classic deck type.
type GermanClassicDeck = Deck GermanClassicRank GermanSuit WildCardNone

-- | German classic deck instance.
germanClassicDeck :: GermanClassicDeck
germanClassicDeck = deck
